Interface: Button<K>

Type parameters

Name	Type
K	extends keyof ButtonRPCPayload = keyof ButtonRPCPayload

Hierarchy

• PluginElement

  ↳ Button

Properties

onClick

• onClick: Signal<ButtonRPCPayload[K][``"onClick"``]["input"] extends undefined ? void : ButtonRPCPayload[K][``"onClick"``]["input"]>

When the toolbar button has a group, it does not have a click event. It's click event is instead used to show the group

Param

Identifies which group button was clicked. Obsolete when the toolbar button does not have a group.

---

remove

• remove: () => Promise<void>

Type declaration

▸ (): Promise<void>

Throws

UIError

Returns

Promise<void>

Inherited from

PluginElement.remove

---

update

• update: (payload: ButtonRPCPayload[K][``"add"``]) => Promise<void>

Type declaration

▸ (payload): Promise<void>

Throws

UIError

Parameters

Name	Type
payload	ButtonRPCPayload[K][``"add"``]

Returns

Promise<void>